core/androidx.core.app/[main]NotificationCompat/BigPictureStyle

BigPictureStyle

open class BigPictureStyle : NotificationCompat.Style(source)

Helper class for generating large-format notifications that include a large image attachment. If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so: 

Notification notification = new NotificationCompat.Builder(mContext)
    .setContentTitle("New photo from " + sender.toString())
    .setContentText(subject)
    .setSmallIcon(R.drawable.new_post)
    .setLargeIcon(aBitmap)
    .setStyle(new Notification.BigPictureStyle()
        .bigPicture(aBigBitmap))
    .build();
Content copied to clipboard

See also

Constructors

Link copied to clipboard
constructor()
constructor(@Nullable builder: @Nullable NotificationCompat.Builder)

Functions

Link copied to clipboard
Link copied to clipboard
@NonNull
open fun bigLargeIcon(@Nullable b: @Nullable Bitmap): @NonNull NotificationCompat.BigPictureStyle
@RequiresApi(value = 23)
@NonNull
open fun bigLargeIcon(@Nullable i: @Nullable Icon): @NonNull NotificationCompat.BigPictureStyle
Override the large icon when the big notification is shown.
Link copied to clipboard
@NonNull
open fun bigPicture(@Nullable b: @Nullable Bitmap): @NonNull NotificationCompat.BigPictureStyle
Provide the bitmap to be used as the payload for the BigPicture notification.
@RequiresApi(value = 31)
@NonNull
open fun bigPicture(@Nullable i: @Nullable Icon): @NonNull NotificationCompat.BigPictureStyle
Provide an icon to be used as the payload for the BigPicture notification.
Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP_PREFIX)
@Nullable
open fun getPictureIcon(@Nullable extras: @Nullable Bundle): @Nullable IconCompat
Link copied to clipboard
@NonNull
open fun setBigContentTitle(@Nullable title: @Nullable CharSequence): @NonNull NotificationCompat.BigPictureStyle
Overrides ContentTitle in the big form of the template.
Link copied to clipboard
@RequiresApi(value = 31)
@NonNull
open fun setContentDescription(@Nullable contentDescription: @Nullable CharSequence): @NonNull NotificationCompat.BigPictureStyle
Set the content description of the big picture.
Link copied to clipboard
@NonNull
open fun setSummaryText(@Nullable cs: @Nullable CharSequence): @NonNull NotificationCompat.BigPictureStyle
Set the first line of text after the detail section in the big form of the template.
Link copied to clipboard
@RequiresApi(value = 31)
@NonNull
open fun showBigPictureWhenCollapsed(show: Boolean): @NonNull NotificationCompat.BigPictureStyle
When set, the big picture of this style will be promoted and shown in place of the large icon in the collapsed state of this notification.